home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / comms / tw215doc.arj / TEXTWIN.MAN < prev    next >
Text File  |  1994-03-24  |  20KB  |  780 lines
  1. textwin.man  March 94
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                TTTTT EEEEE X   X TTTTT W   W III N   N
  15.                  T   E      X X    T   W   W  I  NN  N
  16.                  T   EEEE    X     T   W W W  I  N N N
  17.                  T   E      X X    T   W W W  I  N  NN
  18.                  T   EEEEE X   X   T    W W  III N   N
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.     Contents.
  65.  
  66.     1. Introduction.
  67.  
  68.     2. Getting started.
  69.  
  70.     3. TEXTWIN.CFG commands
  71.  
  72.     4. Example TEXTWIN.CFG
  73.  
  74.     5. Where to find source docs etc.
  75.  
  76.     6. Credits, comments etc.
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  1. Introduction and notes to new textwin users, by Anthony McCarthy
  123.  
  124.   "Textwin" is KA9Q with textual windows.  It is intended, initially,
  125.   to be a drop-in replacement for the DIS NET.EXE program I assume you
  126.   are already successfully using.  Textwin is the same KA9Q with a new
  127.   front end. Any changes to the DIS version of KA9Q will (eventually) 
  128.   appear in textwin too.
  129.  
  130.   Textwin is designed to be used in conjunction with a mouse. It does
  131.   not _require_ a mouse but a mouse is by far the most convenient way
  132.   of manipulating window positions, etc. 
  133.  
  134.   This program exists because of the difficulty I experienced in
  135.   effectively using KA9Q with only a one-session-per-screen display.
  136.   Swapping between telnet, ftp and command sessions was tricky. With
  137.   textwin, you can keep an eye on the progress of an ftp session, say,
  138.   while telnetting on another session -- simply by glancing at another
  139.   window, rather than hitting F10, etc...
  140.  
  141.   Textwin is an ongoing experiment. It has been developed by me
  142.   (amc@beryl.demon.co.uk) in my spare time to satisfy my own needs, 
  143.   but I hope it can be of use to others.
  144.  
  145.   Textwin is not properly documented yet.  You should read the KA9Q
  146.   documentation (ka9qnos.txt) for anything relating to FTP, TELNET, PPP,
  147.   etc, etc. Look in here, or in textwin.cfg, for things relating to the
  148.   screen.
  149.  
  150.   Oh, textwin is free and will remain so.  However, being free,
  151.   I can't undertake to provide support or guarantee that it won't
  152.   do terrible things to your hard disk. If this is unacceptable, do
  153.   not use textwin!  Having said that, while my interest in KA9Q,
  154.   DIS and the Internet continues I will be using textwin myself and
  155.   encourage bug reports and enhancement requests from all.
  156.  
  157.   Once you've seen textwin running, you'll probably want to configure
  158.   some things.  Read textwin.cfg for more info about textwin options.
  159.   But, happily, you don't HAVE to read this junk to get going _now_! 
  160.  
  161.   If you have any questions, problems or bugs, please raise them in 
  162.   the demon.ip.support.pc newsgroup.  I'll endeavour to respond in a
  163.   day or so to any problem that appears to be textwin-specific.
  164.   (If no response is forthcoming, do feel free to send me mail!)
  165.  
  166.   Availablility: if you're reading this you probably already know that
  167.   the latest publically available release of textwin can be obtained
  168.   via anonymous-ftp from ftp.demon.co.uk in the /pub/ibmpc/textwin
  169.   directory.  Source is available but (due to laziness) may not have
  170.   been uploaded to demon.  If you wish to have the latest sources,
  171.   send mail to the most recent "Mr TextWin" (see the final section
  172.   of this manual for details).
  173.  
  174. Anthony McCarthy
  175.  
  176. amc@beryl.demon.co.uk
  177. amccarthy@cix.compulink.co.uk
  178. 100012.3712@compuserve.com
  179.  
  180.  
  181.  
  182.  2. Getting started.
  183.  
  184.   As textwin is a simple replacement for ka9q (NET.EXE) as supplied in
  185.   the DIS starter package, you don't require to do anything other than
  186.   rename the .EXE file to NET.EXE and copy it over the DIS supplied
  187.   NET.EXE, and everything should work as normal - it's that easy.
  188.  
  189.   However, if you wish to take advantage of the extra features of textwin
  190.   then you'll need to create a file called TEXTWIN.CFG and put it in the
  191.   same directory as AUTOEXEC.NET - see section 3. for a list of TEXTWIN.CFG
  192.   commands.
  193.  
  194.   Once running textwin looks a bit different from the normal ka9q, all
  195.   your sessions, as listed by the 'session' command at the net> prompt
  196.   appear in seperate windows. You can use the mouse to move/size the 
  197.   windows in much the same way as you can in various other windowing
  198.   environments.
  199.  
  200.   In addition there are keyboard shortcuts to allow you to manipulate
  201.   the windows without the use of a mouse.
  202.  
  203.   CTRL+cursor key  Size the current window 
  204.   ALT+cursor key   Move the current window
  205.   ALT+F6           Cycle to next window
  206.  
  207.   You can also use the 'session <n>' command at the net> prompt to bring
  208.   any given session to the top.
  209.  
  210.   With a large (132x44) screen you can see most of three or four windows
  211.   at a time on screen - useful for keeping an eye on that big ftp session
  212.   while you're chatting away on IRC.
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  3. TEXTWIN.CFG commands
  243.  
  244.   This section gives a list and brief description of the commands
  245.   available in TEXTWIN.CFG
  246.  
  247.  borders <on | off>
  248.  
  249.    do you want borders around windows? Borders make windows
  250.    slower to draw when moveing/resizing and occupy screen space.
  251.    Windows without borders can be difficult to distinguish from
  252.    other windows and are harder to move/resize.
  253.    [Default: on]
  254.  
  255.  
  256.  colour <fg> <bg>
  257.  
  258.    where <fg> and <bg> are integers in the range 0 to 15
  259.    Valid values depend upon the capabilities of your display
  260.    adaptor. For colour systems: bit0=blue, bit1=green, bit2=red,
  261.    and bit3=intensity.
  262.    [Default: 7 1 (white on blue)]
  263.  
  264.  
  265.  default cascade <x-range> <y-range>
  266.  
  267.    where <x-range> and <y-range> specify the offset limits when
  268.    creating new windows. A new window will be placed at a position
  269.    somewhere between (defPosX, defPosY) and 
  270.    (defPosX+cascadeRangeX-1, defPosY+cascadeRangeY-1), assuming
  271.    that x-range and y-range are not zero.  Specifying zero for these
  272.    parameters ensures that a window will appear at the default
  273.    position. If these parameters are not zero, windows will appear
  274.    successively further down and to the right of the screen, until
  275.    the x-range and y-range limits are reached. That isn't very
  276.    clear. Play with them and see!  
  277.    [Default: 10 10]
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  default character <which> <what>
  303.  
  304.    you can configure the characters used in window borders to be any
  305.    character from the PC character set.
  306.    Even values of <which> apply to inactive windows; odd values are
  307.    for the active window. So, use the following values to select the
  308.    value for <which>, and then add 1 if you want to change the character
  309.    for the active window.
  310.  
  311.      0:vert border      2:horz border      4:top left      6:bot left    
  312.      8:top right       10:bot right       12:(unused)     14:(unused)     
  313.     16:(unused)        18:(unused)        20:(unused)     22:restore        
  314.     24:maximize        26:minimize        28:left scroll  30:right scroll    
  315.     32:up scroll       34:down scroll     36:horz thumb   38:vert thumb 
  316.     40:horz scrollbar  42:vert scrollbar
  317.  
  318.    eg: to make the inactive left vertical border (<which> == 0) into a 
  319.        smiley face (character 1) you would use this command in textwin.cfg:
  320.            default character 0 1
  321.  
  322.        to make the ACTIVE left vertical border (<which> == 0 + 1) into
  323.        a column of exclamation marks (character 33) you would use:
  324.            default character 1 33
  325.  
  326.    This command can be used interactively too. New characters apply
  327.    to subsequent new windows only. eg: "text def char 11 4" will change
  328.    the bottom right corner of new active windows into a diamond.
  329.  
  330.    If you specify a value for <which> out of the range 0 - 43 you'll
  331.    get an error message.
  332.  
  333.    (For the curious: the "(unused)" entries above are placeholders for
  334.    other forms characters such as 'cross', 'T-junction', etc, which are
  335.    not used in textwin at the moment.)
  336.  
  337.  
  338.  default position <x> <y>
  339.  
  340.    specify the position of the next window to be created. Both 
  341.    <x> and <y> may be negative. If <y> is negative, you'll have
  342.    a hard time trying to drag the window to a new location!
  343.    [Default: 0 0]
  344.  
  345.  
  346.  default size <width> <height>
  347.  
  348.    specify the dimensions of the next window to be created.
  349.    These dimensions are limited to the terminal dimensions.
  350.    [Default: 80 25]
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  emulation default <sess-type> [<emul-name>]
  363.  
  364.    Sets the default terminal emulation to be used for all subsequent 
  365.    windows of the specified session type.  Telnet defaults to VT102,
  366.    all other sessions are TTY by default.
  367.  
  368.         <sess-type> is the session type number, encoded as follows:
  369.                        1=Telnet
  370.                        2=FTP
  371.                        3=AX25
  372.                        4=Finger
  373.                        5=Ping
  374.                        6=NET/ROM
  375.                        7=Command
  376.                        8=More
  377.                        9=Hopcheck
  378.                       10=Tip
  379.                       11=PPP PAP
  380.                       12=Dial
  381.                       13=Query
  382.                       14=Cache
  383.                       15=rlogin
  384.  
  385.         <emul-name> is the name of a terminal emulation.
  386.                     Case is irrelevant.
  387.                     Currently available emulation names are:
  388.                       TTY
  389.                       VT102
  390.                       BigVT102
  391.  
  392.  
  393.  hardmouse <on | off> [[[ NB: THIS WILL BECOME OBSOLETE RSN ]]]
  394.  
  395.    hardmouse on may cause display problems in some text display
  396.    modes. hardmouse off results in a sluggish mouse cursor but
  397.    with no display problems. Try hardmouse on first. If you get 
  398.    screen corruption use hardmouse off.
  399.    [Default: off]
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  key <action> [<ch1> [<ch2>]]
  423.  
  424.    Allows the user to view and set the keystroke which is bound to the
  425.    specified action.  Configurable action values are documented below.
  426.    ch1 and ch2 specify the key codes as returned by the int 21 func 6
  427.    service routine (direct console i/o).  If ch1 is non-zero, ch2 need
  428.    not be specified and will be ignored. If ch2 is specified, ch1 should
  429.    be zero.  To do this rationally, you will probably need access to a 
  430.    table of extended key codes. (I used Appendix B of the
  431.    "MS-DOS Programmer's Reference".)  If you want to disable keyboard
  432.    access for a specific action, set both ch1 and ch2 to zero.
  433.  
  434.       action  description              default key binding
  435.         0     move window left         ALT+<left arrow>
  436.         1     move window right        ALT+<right arrow>
  437.         2     move window up           ALT+<up arrow>
  438.         3     move window down         ALT+<down arrow>
  439.         4     reduce window width      CTRL+<left arrow>
  440.         5     increase window width    CTRL+<right arrow>
  441.         6     reduce window height     CTRL+<up arrow>
  442.         7     increase window height   CTRL+<down arrow>
  443.         8     switch to next window    ALT+F6
  444.  
  445.    For example:
  446.       "textwin key 0 97"    causes 'a' to move the current window left
  447.                             (this is possible, if somewhat silly!)
  448.       "textwin key 0 0 97"  causes CTRL+F4 to move the current window left
  449.       "textwin key 0"       shows the key codes which will cause the
  450.                             current window to be moved left
  451.  
  452.  
  453.  mouse <kind_of_mouse>
  454.  
  455.    kind_of_mouse can be 'soft' (software mouse) or 'hard' (hardware mouse)
  456.    Please note that this mechanism is more flexible than hardmouse
  457.    documented above and should be used in preference to it.
  458.    A hardware mouse may cause problems in some display modes if the
  459.    mouse driver software doesn't know how to handle a display
  460.    configuration correctly. For example, mode 0x54 on my S3 card
  461.    is 132 x 43 and the mouse leaves droppings all over the screen.
  462.    Try "mouse hard" first. If you get problems, use "mouse soft".
  463.    (Also, note that due to extreme laziness on my part the mouse
  464.    kind will be reported as '0' or '1' for 'soft' and 'hard' types
  465.    respectively. This will be fixed RSN.)
  466.    [NB: for the curious, I started using the 'mouse' subcommand rather
  467.    than 'hardmouse' due to the (transient) introduction of a new mouse
  468.    kind: 'pretty'. This mouse was a software driven graphical mouse.
  469.    The mouse was drawn by redefining fonts on-the-fly. Although I got
  470.    the code to work, I felt this feature to be simply too expensive
  471.    in terms of code/data space and maintainability (though clever,
  472.    the techniques used were very much 'hacks', IMHO).]
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  param <which> [<what>]
  483.  
  484.    This is a rather vaguely named subcommand which allows you to
  485.    configure various aspects of textwin without me having to
  486.    add too many new commands, etc.  If the <what> parameter is
  487.    omitted, the current value is displayed.
  488.    Both the <which> and <what> parameters are decimal integers.
  489.    The meaning of the <what> parameter depends upon the <which>
  490.    parameter. Hopefully the following table should make things clear:
  491.  
  492.        which   description of <what>
  493.          1     The ASCII value of the background character used when
  494.                erasing the desktop. Default is 177, a half-tone block.
  495.                Only effective within textwin.cfg.
  496.          2     The software-mouse wibble factor.  When the mouse is
  497.                moved onto a cell, the attribute value under the mouse
  498.                cursor is transformed according to this formula:
  499.                 new_attr := old_attr XOR wibble_factor
  500.                NB: changing this setting interactively will work, but
  501.                    you will probably see mouse droppings! This is not
  502.                    considered a bug and this behaviour will not be 
  503.                    'fixed'.
  504.  
  505.  
  506.  screen mode <scr_mode>
  507.  
  508.    scr_mode is the desired display mode when in textwin
  509.  
  510.  
  511.  screen mono <on | off>
  512.  
  513.    If on, textwin is forced to appear on the monochrome monitor
  514.    of a dual-monitor system.  Obscure.
  515.  
  516.  
  517.  screen restore <on | off>
  518.  
  519.    Set this off if you don't want to restore the screen to its
  520.    original state after textwin exits.  Setting this off will
  521.    reduce memory usage by a few kilobytes (depending on your
  522.    initial display mode).
  523.  
  524.  
  525.  terminal <width> <height>
  526.  
  527.    determines the dimensions of the underlying virtual terminal
  528.    that a window will display
  529.    [Default: 80 25]
  530.  
  531.  
  532.  
  533.  Other textwin commands, NOT valid/appropriate in TEXTWIN.CFG but
  534.  documented here for completeness.  As yet, not all textwin commands
  535.  are documented. Sorry. 
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  clock start [<x> [<y>]]
  543.  
  544.    Creates a windowed clock display. You can optionally specify
  545.    its initial position using the <x> and <y> arguments. The clock
  546.    appears at the top-left if no position is specified.
  547.    I suggest that you put the command:-
  548.       textwin clock start
  549.    as the last line of your autoexec.net file, or enter it manually
  550.    once on line.  Note that the former method will not give an
  551.    accurate indication of on-line time as the clock starts long before 
  552.    the dialer completes. Connection takes about 30 seconds for me.
  553.  
  554.  
  555.  clock stop
  556.  
  557.    Destroys the clock window.
  558.  
  559.  
  560.  clock reset [<seconds>]
  561.  
  562.    Resets the elapsed time to the specified number of seconds.
  563.    Defaults to zero if no argument is supplied.
  564.  
  565.  
  566.  emulation list
  567.  
  568.    Lists the names of the available terminal emulations.
  569.  
  570.  
  571.  emulation session <sess-no> [<emul-name>]
  572.  
  573.    Switches the specified session to use the specified emulation.
  574.    No change occurs if the emulation name is not known.
  575.  
  576.    <sess-no> is the session number (0 is valid here, meaning the
  577.              command processor)
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  4. Example TEXTWIN.CFG
  603.  
  604.      colour 1 7
  605.      terminal 80 38
  606.      mouse soft
  607.      borders on
  608.      default position -1 0
  609.      default size 82 40
  610.      default cascade 0 0
  611.  
  612.     # 84 decimal == 0x54 (132 x 43 on my generic S3 card)
  613.      screen mode 84
  614.  
  615.     # The following give "chunky" scrollbars on the active window
  616.     # rather than my minimalist default!
  617.      
  618.      default character 37 219
  619.      default character 39 219
  620.      default character 41 178
  621.      default character 43 178
  622.  
  623.     # The following commands make scrollbars and resize gadgets
  624.     # disappear from inactive windows (NB: the scrollbars and 
  625.     # resize gadgets ARE still there, its just that the graphics
  626.     # for them are the same as the standard border...)
  627.      
  628.      default character 22 196
  629.      default character 24 196
  630.      default character 26 196
  631.  
  632.      default character 28 196
  633.      default character 30 196
  634.      default character 32 179
  635.      default character 34 179
  636.      default character 36 196
  637.      default character 38 179
  638.      default character 40 196
  639.      default character 42 179
  640.  
  641.  
  642.     # Set Tip sessions to use the VT102 emulation (session 
  643.     # type 10 == Tip) and set Telnet sessions to use BigVT102 
  644.     # (session type 1 == Telnet).
  645.     
  646.      emulation default 10 bigvt102
  647.      emulation default  1 vt102
  648.  
  649.     # The following lines will cause textwin to look very much like the
  650.     # original 'single screen' DIS KA9Q program.
  651.  
  652.     # borders off
  653.     # default cascade 0 0
  654.     # default position 0 0
  655.     # colour 7 0
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  5. Where to find source, docs etc.
  663.  
  664.   The following was correct when this manual was written, for TextWin
  665.   based on ka9q 2.12.  It has not been updated to reflect the latest
  666.   code.
  667.  
  668.   Source code for the full Demon version of ka9q can be found at
  669.  
  670.     ftp.demon.co.uk:/pub/ibmpc/DIS/ka9q212.zip   source code for BC 
  671.                                   /ka9qhelp.zip  mailbox help files
  672.                                   /net212.zip    net.exe & rev hist
  673.                                   /nos212.zip    net.exe & associated
  674.                                                  files
  675.  
  676.   Similar files with names including 215 instead of 212 are probably
  677.   available now in the same location.
  678.  
  679.   Textwin modifications can be found at
  680.  
  681.     ftp.demon.co.uk:/pub/ibmpc/textwin/Textwin.17Oct93.zip
  682.                                       /Textwin.source.17Oct93.zip
  683.                                       /Textwin.slip.17Oct93.zip
  684.                                       /Textwin.man.zip
  685.  
  686.   It is likely that this area will be reorganised in the near future
  687.   (March 94).  No details are available at the time of writing, but
  688.   it is probable that the textwin directory will contain a single
  689.   executable binary and the docs, all historical material will be
  690.   moved to subdirectory textwin/old_versions, and further binaries 
  691.   will be in another textwin subdirectory.
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  6. Credits, comments etc.
  723.  
  724.   The source to the textwin modifications to KA9Q was written by
  725.   Anthony McCarthy
  726.  
  727.     amc@beryl.demon.co.uk
  728.     amccarthy@cix.compulink.co.uk
  729.     100012.3712@compuserve.com
  730.  
  731.   At the time of writing, 29Dec93, Anthony is no longer actively
  732.   supporting textwin. The last few updates to textwin have been
  733.   compiled by me (ipaton@sphere.demon.co.uk), however as I no 
  734.   longer use textwin I can't guarantee that I'll be around to do
  735.   any more updates.
  736.  
  737.         Iain Paton (ipaton@sphere.demon.co.uk) 29Dec93
  738.  
  739.   This manual is almost entirely thanks to the efforts of the
  740.   previous two "Mr TextWin"s (above), but I'll be glad to receive
  741.   suggested changes and improvements.
  742.  
  743.   Modifications to docs, and compilation of TextWin 2.15
  744.   by John Washington
  745.  
  746.         john@wash.demon.co.uk
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.